GET restapi/personal/planner/plansinfo/v1?plansIds[0]={plansIds[0]}&plansIds[1]={plansIds[1]}

Gets list of plans with learning objective and elements attached.

Request Information

URI Parameters

Name	Description	Type	Additional information
plansIds	Requested plan IDs.	Collection of integer	Required

Body Parameters

None.

Response Information

Resource Description

list of plans with learning objective and elements attached.

Collection of Itslearning.RestApi.Entities.Personal.PlanWithObjectivesAndElements

Name	Description	Type	Additional information
CourseId	Id of the course the plan is created for.	integer	None.
CourseName	Name of the course the plan is created for.	string	None.
CourseSyncKey	Sync key of the course the plan is created for.	string	None.
PlanId	Identifier of the plan.	integer	None.
PlanTopicName	Name of the topic the plan belongs to.	string	None.
PlanTopicColor	Color of the topic the plan belongs to.	string	None.
PlanTitle	Title of the plan.	string	None.
PlanDescription	Description of the plan.	string	None.
PlanStartDateTime	The date and time the plan starts.	date	None.
PlanEndDateTime	The date and time the plan ends.	date	None.
CoursePlannerUrl	The URL to pointing to Planner of the course the plans is created for.	string	None.
LearningObjectives	The list of learning objectives specified for the plan.	Collection of Itslearning.RestApi.Entities.Personal.PlanLearningObjectiveBasic	None.
Elements	The list of course elements attached to the plan.	Collection of Itslearning.RestApi.Entities.Personal.PlanElementBasic	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CourseId": 1,
    "CourseName": "sample string 2",
    "CourseSyncKey": "sample string 3",
    "PlanId": 4,
    "PlanTopicName": "sample string 5",
    "PlanTopicColor": "sample string 6",
    "PlanTitle": "sample string 7",
    "PlanDescription": "sample string 8",
    "PlanStartDateTime": "2025-05-17T17:37:21Z",
    "PlanEndDateTime": "2025-05-17T17:37:21Z",
    "CoursePlannerUrl": "sample string 11",
    "LearningObjectives": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "IsFromRepository": true,
        "Type": 1
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "IsFromRepository": true,
        "Type": 1
      }
    ],
    "Elements": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Type": "Unknown",
        "IsMarkedAsHomework": true,
        "IconUri": "sample string 4"
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Type": "Unknown",
        "IsMarkedAsHomework": true,
        "IconUri": "sample string 4"
      }
    ]
  },
  {
    "CourseId": 1,
    "CourseName": "sample string 2",
    "CourseSyncKey": "sample string 3",
    "PlanId": 4,
    "PlanTopicName": "sample string 5",
    "PlanTopicColor": "sample string 6",
    "PlanTitle": "sample string 7",
    "PlanDescription": "sample string 8",
    "PlanStartDateTime": "2025-05-17T17:37:21Z",
    "PlanEndDateTime": "2025-05-17T17:37:21Z",
    "CoursePlannerUrl": "sample string 11",
    "LearningObjectives": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "IsFromRepository": true,
        "Type": 1
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "IsFromRepository": true,
        "Type": 1
      }
    ],
    "Elements": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Type": "Unknown",
        "IsMarkedAsHomework": true,
        "IconUri": "sample string 4"
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Type": "Unknown",
        "IsMarkedAsHomework": true,
        "IconUri": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPlanWithObjectivesAndElements xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PlanWithObjectivesAndElements>
    <CourseId>1</CourseId>
    <CourseName>sample string 2</CourseName>
    <CoursePlannerUrl>sample string 11</CoursePlannerUrl>
    <CourseSyncKey>sample string 3</CourseSyncKey>
    <Elements>
      <PlanElementBasic>
        <IconUri>sample string 4</IconUri>
        <Id>1</Id>
        <IsMarkedAsHomework>true</IsMarkedAsHomework>
        <Title>sample string 2</Title>
        <Type>Unknown</Type>
      </PlanElementBasic>
      <PlanElementBasic>
        <IconUri>sample string 4</IconUri>
        <Id>1</Id>
        <IsMarkedAsHomework>true</IsMarkedAsHomework>
        <Title>sample string 2</Title>
        <Type>Unknown</Type>
      </PlanElementBasic>
    </Elements>
    <LearningObjectives xmlns:d3p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Personal">
      <d3p1:PlanLearningObjectiveBasic>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsFromRepository>true</d3p1:IsFromRepository>
        <d3p1:Title>sample string 2</d3p1:Title>
        <d3p1:Type>Subject</d3p1:Type>
      </d3p1:PlanLearningObjectiveBasic>
      <d3p1:PlanLearningObjectiveBasic>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsFromRepository>true</d3p1:IsFromRepository>
        <d3p1:Title>sample string 2</d3p1:Title>
        <d3p1:Type>Subject</d3p1:Type>
      </d3p1:PlanLearningObjectiveBasic>
    </LearningObjectives>
    <PlanDescription>sample string 8</PlanDescription>
    <PlanEndDateTime>2025-05-17T17:37:21Z</PlanEndDateTime>
    <PlanId>4</PlanId>
    <PlanStartDateTime>2025-05-17T17:37:21Z</PlanStartDateTime>
    <PlanTitle>sample string 7</PlanTitle>
    <PlanTopicColor>sample string 6</PlanTopicColor>
    <PlanTopicName>sample string 5</PlanTopicName>
  </PlanWithObjectivesAndElements>
  <PlanWithObjectivesAndElements>
    <CourseId>1</CourseId>
    <CourseName>sample string 2</CourseName>
    <CoursePlannerUrl>sample string 11</CoursePlannerUrl>
    <CourseSyncKey>sample string 3</CourseSyncKey>
    <Elements>
      <PlanElementBasic>
        <IconUri>sample string 4</IconUri>
        <Id>1</Id>
        <IsMarkedAsHomework>true</IsMarkedAsHomework>
        <Title>sample string 2</Title>
        <Type>Unknown</Type>
      </PlanElementBasic>
      <PlanElementBasic>
        <IconUri>sample string 4</IconUri>
        <Id>1</Id>
        <IsMarkedAsHomework>true</IsMarkedAsHomework>
        <Title>sample string 2</Title>
        <Type>Unknown</Type>
      </PlanElementBasic>
    </Elements>
    <LearningObjectives xmlns:d3p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Personal">
      <d3p1:PlanLearningObjectiveBasic>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsFromRepository>true</d3p1:IsFromRepository>
        <d3p1:Title>sample string 2</d3p1:Title>
        <d3p1:Type>Subject</d3p1:Type>
      </d3p1:PlanLearningObjectiveBasic>
      <d3p1:PlanLearningObjectiveBasic>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsFromRepository>true</d3p1:IsFromRepository>
        <d3p1:Title>sample string 2</d3p1:Title>
        <d3p1:Type>Subject</d3p1:Type>
      </d3p1:PlanLearningObjectiveBasic>
    </LearningObjectives>
    <PlanDescription>sample string 8</PlanDescription>
    <PlanEndDateTime>2025-05-17T17:37:21Z</PlanEndDateTime>
    <PlanId>4</PlanId>
    <PlanStartDateTime>2025-05-17T17:37:21Z</PlanStartDateTime>
    <PlanTitle>sample string 7</PlanTitle>
    <PlanTopicColor>sample string 6</PlanTopicColor>
    <PlanTopicName>sample string 5</PlanTopicName>
  </PlanWithObjectivesAndElements>
</ArrayOfPlanWithObjectivesAndElements>